Repository navigation
test(docs): run the get-started page's commands - #50
Merged
Merged
Conversation
The doc walkthrough checked the tutorial and the how-to, reference and explanation pages, but not get-started.org, the first page a site administrator reads. A forbidden path in one of its bash blocks, or a quoted output the binary no longer prints, passed the suite: with --out-dir /path/to/eon-inspect in the inspect block and shards=2 in the quoted shard line, main's doc_walkthrough still passes. org_files() now includes get-started.org, so its bash blocks follow the same path rules. get_started_blocks_print_what_the_page_quotes runs each block with the built binary first on PATH and /tmp moved to a temporary directory, and compares stdout with the example block that follows it. The stack admit block must exit 78 and leave its reservation directory empty, as the page says. Both checks fail on those two edits. The page itself needs no change: all four blocks print what it quotes.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The doc walkthrough tests cover
get-started.organd run its four command blocks.get-started.org. A forbidden path in one of its bash blocks, or a quoted output the binary no longer prints, passed the suite: with--out-dir /path/to/eon-inspectin the inspect block andshards=2in the quoted shard line, main'sdoc_walkthroughstill passed.org_files()now includesget-started.org, so its bash blocks follow the same path rules.get_started_blocks_print_what_the_page_quotesruns each block with the built binary first onPATHand/tmpmoved to a temporary directory, and compares stdout with the example block that follows it. Thestack admitblock must exit 78 and leave its reservation directory empty, as the page says. The page itself needs no change: all four blocks print what it quotes.The commit has a towncrier fragment. Main has no towncrier yet; #26 (
fix/towncrier) adds it.